Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AJ-Ianozi committed Aug 26, 2024
1 parent 27ab8c2 commit 510153f
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 18 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,29 @@ distribution.
* Generating Atom feeds
* Auto reconfigure server when configuration file was changed

## Downloading YASS

The easiest way to get YASS is by downloading the [latest release](https://github.com/yet-another-static-site-generator/yass/releases/latest) for your operating system. For example, if you have windows, then download ` yass-windows_x86_64.zip`.

## Build from sources

### Using alire
To install it, simply run `alr install yass` and yass will automatically be

The easiest way to build YASS is via [Alire](https://alire.ada.dev/). If don't
have alire already, you can get it from the main website or auto-install it via
[Getada.dev](https://www.getada.dev/).

To build and install it, simply run `alr install yass` and yass will automatically be
added to alire's binary folder (default is `$HOME/.alire/bin`).

If you'd rather just download and build manually, either run `alr get yass` or
clone this repository and run `alr update && alr build`.
If you'd rather just download and build manually, navigate to a folder where you
wish to build YASS and issue the following commands:
1. `alr get yass`
2. `cd yass*`
3. `alr update && alr build`
YASS will now be in the project's `./bin` directory.

This should automatically pull all of the dependencies in, including libcmark.
This should automatically pull all of the dependencies in, ie AWS and libcmark.

### Using gprbuild

Expand Down
34 changes: 20 additions & 14 deletions docs/user/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,42 @@
-- detailslink: []
-- detailslink: requirements
-- detailslink: buildprogram


## <a name="downloading"></a>Downloading

The easiest way to get YASS is by downloading the [latest release](https://github.com/yet-another-static-site-generator/yass/releases/latest) for your operating system. For example, if you have windows, then download ` yass-windows_x86_64.zip`.

## <a name="requirements"></a>Requirements

To run the program or build it from the sources you need *libcmark* library
which should be available in most Linux distributions. If not, you can
download it source code from [GitHub](https://github.com/commonmark/cmark).
Please refer to it documentation on how to compile it.

If you use downloaded AppImage version of the program, you don't need any
other dependencies. More information about using AppImage files you can find
in [AppImage documentation](https://docs.appimage.org/user-guide/run-appimages.html)

<a href="#top">^ Top</a>

## <a name="buildprogram"></a>Build from sources

### Docker way

You can use Docker images `adabuild` and `adabuildwin64` from the project
[Docker Ada](https://www.laeran.pl/repositories/dockerada). They contain all libraries
and compiler needed to build the program.
### Using Alire

To build the program for Linux, download `adabuild` image and type in console:
The easiest way to build YASS is via [Alire](https://alire.ada.dev/). If don't
have alire already, you can get it from the main website or auto-install it via
[Getada.dev](https://www.getada.dev/).

`docker run --rm -v [path to source code]:/app ghcr.io/thindil/adabuild /bin/bash -c "cd /app && gprbuild -p -P yass.gpr -XMode=release"`
To build and install it, simply run `alr install yass` and yass will automatically be
added to alire's binary folder (default is `$HOME/.alire/bin`).

To build the program for Windows 64-bit, download `adabuildwin64` image and type in console:
If you'd rather just download and build manually, navigate to a folder where you
wish to build YASS and issue the following commands:
1. `alr get yass`
2. `cd yass*`
3. `alr update && alr build`
YASS will now be in the project's `./bin` directory.

`docker run --rm -v [path to source code]:/app ghcr.io/thindil/adabuildwin64 /bin/bash -c "cd /app && gprbuild -p -P yass.gpr -XMode=release --target=x86_64-windows"`
This should automatically pull all of the dependencies in, ie AWS and libcmark.

### Classic way
### Using gprbuild

#### Preparations

Expand Down

0 comments on commit 510153f

Please sign in to comment.