From e3b2fabf2096dcb372e8735aa0f5b19946287ff1 Mon Sep 17 00:00:00 2001 From: Samuel Roland Date: Thu, 22 Aug 2024 11:30:44 +0200 Subject: [PATCH] fix: move installation details from report.md to install.md --- docs/src/install.md | 41 ++++++++++++++++++++++++++++++++++++++++- docs/src/report.md | 39 --------------------------------------- 2 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/src/install.md b/docs/src/install.md index b743fda..4b91b24 100644 --- a/docs/src/install.md +++ b/docs/src/install.md @@ -1 +1,40 @@ -# Chapter 1 +# Installation instructions + +## Installation for development +### Environment + +1. Install the Rust toolchain via `rustup` on [rustup.rs](https://rustup.rs/) +1. Install xmake on [xmake.io](https://xmake.io/#/guide/installation) +1. Clone the repository `git clone git@github.com:plx-pdg/plx.git` +1. We need to define how exos files are edited, for this we choose the standard `$EDITOR` environment variable + 1. You can choose any command line editor like `nano, vim, nvim` or others, but GUI IDE also works `code, codium, idea`, as a replacement of `` below. + 1. On Mac and Linux you should change your shell configuration (`~/.bashrc` for ex.) with a line like `export EDITOR=` + 1. On Windows `setx /m EDITOR ` (check it worked you can run `echo %EDITOR%` in a new terminal) + 1. In case it doesn't work, make sure to reload your shell + 1. When you enter an exo your $EDITOR will automatically open the correct file + +### Build +```sh +cargo build +# or in release mode +cargo build --release +``` + +You can find the result binary in `target/debug/plx` and `target/release/plx`. + +### Run +To run the binary without knowning its path just run `cargo run`. + +## Production usage +We do not provide binaries for the project so you have to compile it yourself but it is easy via cargo. + +1. Install the Rust toolchain via `rustup` on [rustup.rs](https://rustup.rs/) +1. Install xmake on [xmake.io](https://xmake.io/#/guide/installation) + +To install PLX without cloning the repository, you can install and compile it from `crates.io` with + +```sh +cargo install plx +``` + +And then just run the `plx` command in your terminal. (If it is not found make sure you restart your terminal or check if `~/.cargo/bin/` is in your $PATH). diff --git a/docs/src/report.md b/docs/src/report.md index 8749a84..4285e53 100644 --- a/docs/src/report.md +++ b/docs/src/report.md @@ -1,42 +1,3 @@ -## Installation for development -### Environment - -1. Install the Rust toolchain via `rustup` on [rustup.rs](https://rustup.rs/) -1. Install xmake on [xmake.io](https://xmake.io/#/guide/installation) -1. Clone the repository `git clone git@github.com:plx-pdg/plx.git` -1. We need to define how exos files are edited, for this we choose the standard `$EDITOR` environment variable - 1. You can choose any command line editor like `nano, vim, nvim` or others, but GUI IDE also works `code, codium, idea`, as a replacement of `` below. - 1. On Mac and Linux you should change your shell configuration (`~/.bashrc` for ex.) with a line like `export EDITOR=` - 1. On Windows `setx /m EDITOR ` (check it worked you can run `echo %EDITOR%` in a new terminal) - 1. In case it doesn't work, make sure to reload your shell - 1. When you enter an exo your $EDITOR will automatically open the correct file - -### Build -```sh -cargo build -# or in release mode -cargo build --release -``` - -You can find the result binary in `target/debug/plx` and `target/release/plx`. - -### Run -To run the binary without knowning its path just run `cargo run`. - -## Production usage -We do not provide binaries for the project so you have to compile it yourself but it is easy via cargo. - -1. Install the Rust toolchain via `rustup` on [rustup.rs](https://rustup.rs/) -1. Install xmake on [xmake.io](https://xmake.io/#/guide/installation) - -To install PLX without cloning the repository, you can install and compile it from `crates.io` with - -```sh -cargo install plx -``` - -And then just run the `plx` command in your terminal. (If it is not found make sure you restart your terminal or check if `~/.cargo/bin/` is in your $PATH). - ## Project description TODO: functionnal and non fonctionnal goals