Skip to content

Commit

Permalink
doc: update README (#77)
Browse files Browse the repository at this point in the history
* doc: update README

* doc: update pom.xml
  • Loading branch information
Ronnie Song authored Aug 15, 2019
1 parent 2220a9c commit b38cffb
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A FTP (or File Transfer Protocol) client that is used for the transfer of comput
## Links
* [GitHub Page](https://psu-agile-group.github.io/FTP-Client/)
* [Repository](https://github.com/psu-agile-group)
* [Backlog](https://github.com/psu-agile-group/psu-agile-group.github.io/blob/master/BACKLOG.md)
* [Backlog](https://github.com/psu-agile-group/FTP-Client/blob/master/BACKLOG.md)

## Tech stack, Tools, Prerequisites and Setup
- [x] Java
Expand All @@ -30,8 +30,23 @@ A FTP (or File Transfer Protocol) client that is used for the transfer of comput
- [x] Travis-CI
- [x] Circle-CI

####   Build
  [Wiki Page](https://github.com/psu-agile-group/FTP-Client/wiki/Setup)
## Build and Run
You can download executables and source code from the [releases](https://github.com/psu-agile-group/FTP-Client/releases) page.

### Build with the Source Code
Please go to our [wiki page](https://github.com/psu-agile-group/FTP-Client/wiki/Setup) for more details.

### Run Linux Released Executables
unpack the `FTP-Client-Linux.tar.gz`, change your working directory, then run.
```shell
$ cd FTP-Client-Linux
```
```shell
$ ./run.sh
```
ps: `chmod +x run.sh` or replace `#!/bin/sh` to `#!/bin/bash` in `run.sh` if needed.

### For Windows Released Executables
unpack the `FTP-Client-Windows.exe`, open FTP-Client-Windows folder, then launch `run.exe` by double click.


####   Run
  [Wiki Page](https://github.com/psu-agile-group/FTP-Client/wiki/Run)
14 changes: 14 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@
<useSystemClassLoader>false</useSystemClassLoader>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<manifest>
<mainClass>com.psuagilegroup.App</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
</build>
<version>1.0-SNAPSHOT</version>
Expand Down

0 comments on commit b38cffb

Please sign in to comment.