Skip to content
This repository has been archived by the owner on Dec 18, 2018. It is now read-only.

Commit

Permalink
new README
Browse files Browse the repository at this point in the history
  • Loading branch information
lcarcone committed Feb 4, 2014
1 parent 7758457 commit 5685a71
Show file tree
Hide file tree
Showing 2 changed files with 150 additions and 0 deletions.
109 changes: 109 additions & 0 deletions README.amaya
@@ -0,0 +1,109 @@

Amaya Release


About this Release
==================

Amaya is intended to be a comprehensive environment for testing and
evaluating new proposals for Web standards and formats. The first version of
this testbed was released in April 1996.
For more information: http://www.w3.org/Amaya

Feedback and Contribution
-------------------------
As the main objective of this early release is to get feedback from future
users, comments, questions, bug reports, and contributions are welcome.

For communicating with the Amaya team, please use the mailing list:

o www-amaya@w3.org for user topics
For subscribing to the mailing list, send a message to:
www-amaya-request@w3.org
with a body containing the line:
subscribe
A history is maintained at the following URL:
http://lists.w3.org/Archives/Public/www-amaya/

o www-amaya-dev@w3.org for more technical topics (i.e. developers)
For subscribing to the mailing list, send a message to:
www-amaya-dev-request@w3.org
with a body containing the line:
subscribe
A history is maintained at the following URL:
http://lists.w3.org/Archives/Public/www-amaya-dev/

o www-amaya-doc@w3.org for the documentation and translations
For subscribing to the mailing list, send a message to:
www-amaya-doc-request@w3.org
with a body containing the line:
subscribe
A history is maintained at the following URL:
http://lists.w3.org/Archives/Public/www-amaya-doc/

Copyright
---------
Amaya is covered by the W3C and INRIA Copyright Statements. Please read the
COPYRIGHT files in sub-directories.

How to Install Amaya Binary Release
===================================

On Windows platforms, the distribution includes an installer:
A simple double-clic allows you to install Amaya (so skip this section).
By default, the executable file Amaya is located at
c:\Program Files\Amaya\windows\bin\amaya.exe
and a shortcut is automatically created.

On Unix platforms and if the distribution is a tar.gz file follow
these instructions.

Choose a place for Amaya
------------------------
Supposing the binary distribution was loaded fine, one must choose a place
to install it. We suggest

* /usr/local for a UNIX system wide installation
* a user home directory for a personnal installation

Extract the distribution
------------------------
Move the distribution to this directory, verify the rights on this directory
allows you to create a directory and extract the distribution:
tar xzvf amaya-system.tar.gz


Set up the Environment and Start Amaya
--------------------------------------
The file Amaya/$platform/bin/amaya is the executable file Amaya, the
best thing is to add this path to your PATH environment variable:
When using sh, bash or another variant of the Bourne shell
PATH=$PATH:/usr/local/Amaya/$platform/bin ; export $PATH
Maybe this command should be added to the .login startup script.
You can also add a link from /usr/bin/amaya or /usr/local/bin/amaya.

Once done one can lauch amaya simply by typing "amaya" to the shell prompt.
The Amaya main window should open and display a page of information.

How to Compile Amaya Source Release
===================================

Extract the distribution
------------------------
Move the distribution to the correct directory (your $HOME for example).
Extract the source tar file: amaya-src-release.tar.gz

Set up the environment and start the compiling
----------------------------------------------
You have to create a new directory platform-name or obj within the
directory Amaya. Then you have to call the configure application, which
is in the Amaya directory, from within this subdirectory.
For example, if we want to compile Amaya in a LINUX platform, we could do the
following:
[1]>cd Amaya
[2]>mkdir linux
[3]>cd linux
[4]>../configure

See http://www.w3.org/Amaya/User/Autoconf.html for more information.

41 changes: 41 additions & 0 deletions README.md
@@ -0,0 +1,41 @@
<a name="overview"/>
## Amaya

Amaya is a Web editor, i.e. a tool used to create and update documents directly on the Web.<br/>
Browsing features are seamlessly integrated with the editing and remote access features in a uniform environment.<br/>
This follows the original vision of the Web as a space for collaboration and not just a one-way publishing medium.

<a name="resources"/>
- **Homepage:** <http://www.w3.org/Amaya>
- **Mailing list:** <http://www.w3.org/Amaya/User/Mailing.html>
- **Source code:** <https://github.com/w3c/Amaya>
- **Documentation:** <http://www.w3.org/Amaya/User/>

<a name="copyright"/>
Copyright © 1994-2012 INRIA and W3C® (MIT, ERCIM, Keio).

<a name="distribution"/>
## Distributions
<http://www.w3.org/Amaya/User/BinDist.html>

<a name="source"/>
## Sources
The Amaya source tree can be found in the directory Amaya of this project.
(also available from <http://www.w3.org/Amaya/User/SourceDist.html>).


<a name="libraries"/>
## External Libraries
Amaya uses several external librarie (libwww, Mesa, redland, wxWidgets, freetype).
They can be found in the tar file located in the directory Library or in the Amaya page
<http://www.w3.org/Amaya/User/SourceDist.html>


<a name="compilation"/>
## Compilation
<http://www.w3.org/Amaya/User/Overview.html>

<a name="faq"/>
## FAQ
<http://www.w3.org/Amaya/User/FAQ.html>

0 comments on commit 5685a71

Please sign in to comment.