doc(build): add instructions
This commit is contained in:
parent
32f99dba49
commit
1677a89a05
1 changed files with 37 additions and 47 deletions
84
README.md
84
README.md
|
@ -1,62 +1,52 @@
|
|||
# Graph & Algorithm project — INSA Toulouse
|
||||
|
||||
## How to start?
|
||||
## Building
|
||||
|
||||
You will not be able to use this repository to save your work, you need to copy / import / fork it to
|
||||
your favorite Git platform.
|
||||
The instructions below are an attempt at using java from the command line.
|
||||
These efforts were in vain (~3 man-hours + help from 2 teachers). The
|
||||
"solution" was to use [VScode][vscode]. The instructions are left below for
|
||||
posterity.
|
||||
|
||||
### Importing to [Github](https://github.com), [Bitbucket](https://bitbucket.org) or [Gitlab](https://gitlab.com):
|
||||
[vscode]: https://code.visualstudio.com/docs/setup/linux
|
||||
|
||||
You first need to register and then log in to the platform you want. The steps to import the project are detailed below:
|
||||
### Prerequisites
|
||||
|
||||
#### Github
|
||||
This project makes use of [Maven][maven]. On a debian-like system, install Maven :
|
||||
|
||||
1. In the upper-right corner of any page, click the **"+"** icon, then click **Import repository**, or go to [https://github.com/new/import](https://github.com/new/import).
|
||||
2. Paste the following URL in the first input:
|
||||
[https://gitea.typename.fr/INSA/be-graphes.git](https://gitea.typename.fr/INSA/be-graphes.git)
|
||||
3. Choose the name you want for the repository.
|
||||
4. Click *Begin import*.
|
||||
5. Wait for completion... Done!
|
||||
```
|
||||
sudo apt-get install maven
|
||||
```
|
||||
|
||||
#### Bitbucket
|
||||
[maven]: https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
|
||||
|
||||
1. On the left panel of any page, click the **"+"** icon, then **Repository**, and then **Import**, or directly go to [https://bitbucket.org/repo/import](https://bitbucket.org/repo/import).
|
||||
2. Paste the following URL in the first input (select Git as source if not already selected):
|
||||
[https://gitea.typename.fr/INSA/be-graphes.git](https://gitea.typename.fr/INSA/be-graphes.git)
|
||||
3. Choose the name you want for repository, and select Git as the *Version control system*.
|
||||
4. Click *Import repository*.
|
||||
5. Wait for completion... Done!
|
||||
### Compiling
|
||||
|
||||
#### Gitlab
|
||||
In the project root directory :
|
||||
|
||||
1. In the upper-right corner of any page, click the **"+"** icon, then **New project**, or directly go to [https://gitlab.com/projects/new](https://gitlab.com/projects/new).
|
||||
2. Select the **Import project** tab, and then click **Repo by URL** (right-most option).
|
||||
3. Paste the following URL in the first input:
|
||||
[https://gitea.typename.fr/INSA/be-graphes.git](https://gitea.typename.fr/INSA/be-graphes.git)
|
||||
4. Choose the name you want for the repository.
|
||||
5. Click *Create project*.
|
||||
6. Wait for completion... Done!
|
||||
```
|
||||
mvn compile
|
||||
```
|
||||
|
||||
### Importing to another repository provider:
|
||||
### Packaging
|
||||
|
||||
1. Create a new **empty** repository (no README, no LICENSE) on your provider. Let's assume the URL of your repository is `$URL_REPOSITORY`.
|
||||
2. Clone this repository somewhere:
|
||||
In the project root directory :
|
||||
|
||||
```bash
|
||||
git clone https://gitea.typename.fr/INSA/be-graphes.git
|
||||
```
|
||||
|
||||
3. Go inside the newly cloned repository and update the **remote**:
|
||||
|
||||
```bash
|
||||
cd be-graphes
|
||||
git remote set-url origin $URL_REPOSITORY
|
||||
```
|
||||
|
||||
4. Push to your repository:
|
||||
```
|
||||
mvn package
|
||||
```
|
||||
|
||||
```bash
|
||||
push -u origin master
|
||||
```
|
||||
|
||||
Another way is to do a bare clone and then mirror it to your repository: [https://help.github.com/articles/importing-a-git-repository-using-the-command-line/](https://help.github.com/articles/importing-a-git-repository-using-the-command-line/)
|
||||
Or skip tests :
|
||||
|
||||
```
|
||||
mvn package -Dmaven.test.skip=true
|
||||
```
|
||||
|
||||
The output jar files will be in the `<project>/target/` directory of each project.
|
||||
|
||||
### Testing
|
||||
|
||||
In the root directory, start all tests :
|
||||
|
||||
```
|
||||
mvn test
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue