diff --git a/README.md b/README.md index 205fed5..7da0ed7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ZRCola +# ZRCola A Microsoft Windows application for composing texts using a wide range of Slavic (and general) letters from or beyond Unicode. @@ -56,17 +56,9 @@ Use Microsoft NMAKE to build the project. The resulting files can be found in ou The `/ls` flag can be appended to the commands above to reduce NMAKE's verbosity. You can combine multiple targets (e.g. nmake Unregister Clean). Please, see NMAKE reference for further reading. -## Building ZRCola webservice +## Building and installing ZRCola webservice -### Building Environment Requirements -- Linux -- _gcc_, _gcc-c++_, _make_, _cmake_, _libatomic_ - -### Building -Use `make -C ZRColaWS all` to build the project. - -### Installing -Use `sudo make -C ZRColaWS install` to install the project. +ZRCola is also available as a Linux web-service. See [ZRColaWS/README.md](ZRColaWS/README.md) for instructions. ## Translating ZRCola Instructions how to translate ZRCola to your language can be found [here](LOCALIZATION.md). diff --git a/ZRColaWS/README.md b/ZRColaWS/README.md new file mode 100644 index 0000000..89290bf --- /dev/null +++ b/ZRColaWS/README.md @@ -0,0 +1,23 @@ +# ZRCola Web Service + +## Building and Installation + +1. Install prerequisites: `sudo dnf install git cmake gcc gcc-c++ make libatomic` + +2. Clone this Git repository: `git clone --recursive https://github.com/Amebis/ZRCola.git` + +3. Build ZRColaWS: `make -C ZRCola/ZRColaWS` + +4. Install ZRColaWS: `sudo make -C ZRCola/ZRColaWS install` + +5. Configure ZRColaWS by editing _/usr/local/etc/sysconfig/zrcolaws_ + +6. Start ZRColaWS: `sudo systemctl start zrcolaws.service` + +7. Configure ZRColaWS for auto-start: `sudo systemctl enable zrcolaws.service` + +8. Remember to open webservice port in firewall, should the service require external access. + +## Usage + +Web service API documentation is available at _http://host:port/swagger/ui_.