Anonymous avatar Anonymous committed 615bb94

updated install docs, add make mo to quickinstall

Comments (0)

Files changed (3)

docs/admin/install.rst

 
 Installing
 ==========
-For now: DON'T!
+Before you can run moin, you need to install it:
 
-Just run "moin" command from the toplevel directory of your local copy/repo.
+Developer install
+-----------------
+Please make sure you have `virtualenv` installed (it includes `pip`).
 
+If you just want to run moin in-place in your mercurial workdir, run this
+from your mercurial moin2 work dir:
+
+ # you can also just run `quickinstall` script
+ virtualenv --no-site-packages env
+ source env/bin/activate
+ pip install -e .
+ make mo
+
+This will use virtualenv to create a directory `env/` and create a virtual
+environment for moin there. `activate` then activates this environment, so
+that pip will install moin2 including all dependencies into that directory.
+pip will fetch all dependencies from pypi and install them, so this may take
+a while.
+Finally, compile the translations (`*.po` files) to binary `*.mo` files.
+
+Note: in this special mode, it won't copy moin to the env/ directory, it will
+run everything from your work dir, so you can modify code and directly try it
+out (you only need to do this installation procedure once).
+
+Now just run the "moin" command from your work dir to start the builtin server.
+
    devel/support
    devel/translate
 
-Developping of MoinMoin
-=======================
+Developing of MoinMoin
+======================
 
 .. toctree::
    :maxdepth: 2
 source env/bin/activate
 # "install" moin2 from repo to the env
 pip install -e .
+# compile the translations
+make mo
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.