diff --git a/README b/README new file mode 100644 index 0000000..2cacc38 --- /dev/null +++ b/README @@ -0,0 +1,54 @@ +Configuring ease.js +******************* + + Copyright (C) 2013, 2014, 2015 Free Software Foundation, Inc. + + This file is part of GNU ease.js. + + Copying and distribution of this file, with or without modification, are + permitted in any medium without royalty provided the copyright notice and + this notice are preserved. This file is offered as-is, without warranty + of any kind. + + +See also README.md. + +This file contains information on configuring and building GNU ease.js; for +information on using the library, please see the Markdown-formatted README.md +file or the Texinfo manual. + + +Installing +========== + +For information on installing ease.js on your system, see INSTALL. +Alternatively, you may install the software using npm by issuing the +following command: + + $ npm install easejs + + + +Configuring +=========== + +If your distribution contains a `configure' file in the project root, you +may jump immediately to INSTALL. + +Otherwise, you likely have the sources as they exist in the project +repository, which does not contain the generated `configure' script; you +may generate it by issuing the following command: + + $ autoreconf -fvi + +Please note that certain files (such as AUTHORS, NEWS, and ChangeLog) are +generated as part of the `dist' target and do not exist as part of the +repository. + + + +Hacking +======= +For information on hacking and contributing to GNU ease.js, please see +README.hacking. +