/docs/installation.md

http://github.com/jacksonh/manos · Markdown · 158 lines · 94 code · 64 blank · 0 comment · 0 complexity · 2a95f0a8597657232635fd80773324aa MD5 · raw file

  1. Installing Manos
  2. ================
  3. Currently Manos can be installed on Linux, OS X and Windows.
  4. You should read the whole guide before reading your operating system specific instructions.
  5. Files
  6. -----
  7. A properly installed Manos on OS X and Linux should install the following files:
  8. <prefix>/lib/Manos.dll
  9. <prefix>/lib/manos.exe
  10. <prefix>/lib/pkgconfig/manos.pc
  11. <prefix>/bin/manos
  12. <prefix>/share/manos/docs/<documentation files>
  13. <prefix>/share/manos/layouts/default/<the default layout files for new apps>
  14. On windows all files will be installed in the same directory:
  15. <prefix>/Manos.dll
  16. <prefix>/manos.exe
  17. <prefix>/docs/<documentation files>
  18. <prefix>/layouts/default/<the default layout files>
  19. Layouts
  20. -------
  21. Layouts are the files that are copied to your new application directory when you use the manos --init command.
  22. Installing from source
  23. ----------------------
  24. To build Manos from source you must run configure and make from the top level directory. Installation should be as simple as:
  25. ./configure
  26. sudo make install
  27. The configure script also supports changing the installation prefix:
  28. ./configure --prefix=/tmp/install
  29. To verify your installation you can use the manos --docs command. This will create a new server running on http://localhost:8181/ you should be able to navigate there in your browser and view the manos documentation.
  30. Installing Manos on OS X
  31. ------------------------
  32. ### Install Mono 2.8
  33. Grab the Mono 2.8 OSX package from the [Mono Downloads Page](http://mono-project.com/Downloads).
  34. You need to have Mono 2.8 installed on your system. An older Mono install won't cut it. Also, if you've installed Mono from source on your Mac, things might work, things might not work. This guide assumes you have it installed from packages.
  35. ### Install Manos
  36. Now that all the dependencies are installed you should be able to build and install Manos.
  37. git clone https://jacksonh@github.com/jacksonh/manos.git
  38. ./autogen.sh
  39. make
  40. sudo make install
  41. This will install Manos.dll and manos.exe into /usr/local/lib/manos. As well as a .pc file and a manos script for invoking manos.exe
  42. ### Confirm your installation
  43. You should now be able to run the manos documentation server:
  44. manos --docs
  45. and navigate to http://localhost:8181/ in your browser.
  46. Installation on Linux
  47. ---------------------
  48. ### Install Mono 2.8
  49. Follow the distro specific instructions on <http://www.mono-project.com/download> to install Mono 2.8.
  50. Once Mono 2.8 is installed you can verify your installation by typing mono on the command line:
  51. jackson@erm:~$ mono --version
  52. Mono JIT compiler version 2.8 (mono-2-8/57dae7a Mon Oct 4 18:24:09 EDT 2010)
  53. ### Build Dependencies
  54. automake
  55. gcc
  56. make
  57. libtool
  58. ### Install Manos
  59. Checkout Manos from github at <http://github.com/jacksonh/manos/> and build/install it:
  60. jackson@erm:manos$ ./autogen.sh
  61. ...
  62. jackson@erm:manos$ make && sudo make install
  63. ...
  64. To verify your installation you can use the manos --docs command. This will create a new server running on
  65. http://localhost:8181/ you should be able to navigate there in your browser and view the manos documentation.
  66. Installation on OpenBSD
  67. -----------------------
  68. ### Install prerequisites
  69. From ports or packages install mono 2.8
  70. ### Install Manos
  71. Checkout Manos from github at <http://github.com/jacksonh/manos/> and build/install it:
  72. $ ./autogen.sh
  73. ...
  74. $ su
  75. ...
  76. $ gmake install
  77. ...
  78. To verify your installation you can use the manos --docs command. This will create a new server running on
  79. http://localhost:8181/ you should be able to navigate there in your browser and view the manos documentation.
  80. Installation on Windows
  81. ---------------------
  82. ### Install Mono 2.8 (Optional)
  83. Follow the Windows specific instructions on <http://www.mono-project.com/download> to install Mono 2.8.
  84. This step is optional but you will need the Mono.Posix.dll and PosixHelper.dll when you want to compile
  85. a single Manos dll for both Windows and Linux/MacOS.
  86. ### Install Manos
  87. Checkout Manos from github at <http://github.com/jacksonh/manos/> and build/install it using Visual Studio.
  88. If you do no have Mono installed you can define DISABLE_POSIX to remove the Mono.Posix dependency.
  89. ### Copy all files to your install directory
  90. Create a directory for the Manos binary files and copy Manos.dll manos.exe and the entire manos/data/layouts
  91. directory to your new directory. Your structure should look something like this:
  92. C:\Program Files\Manos\manos.exe
  93. C:\Program Files\Manos\Manos.dll
  94. C:\Program Files\layouts\default\<layout files>