Skip to content

Commit

Permalink
add documentation based on intial feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
Udit8348 committed Oct 11, 2024
1 parent 208c5b3 commit 8155173
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Vortex is a full-stack open-source RISC-V GPGPU. Vortex supports multiple *backend drivers*, including our C++ simulator (simx), an RTL simulator, and physical Xilinx and Altera FPGAs-- all controlled by a single driver script. The chosen driver determines the corresponding code invoked to run Vortex. Generally, developers will prototype their intended design in simx, before completing going forward with an RTL implementation. Alternatively, you can get up and running by selecting a driver of your choice and running a demo program.

## Website
Vortex news can be found on its [website](https://vortex.cc.gatech.edu/)

## Specifications

- Support RISC-V RV32IMAF and RV64IMAFD
Expand Down Expand Up @@ -30,7 +33,7 @@ Vortex is a full-stack open-source RISC-V GPGPU. Vortex supports multiple *backe
- `miscs`: Miscellaneous resources.

## Quick Start
The following steps demonstrate how to run Vortex with the default driver: simx. If you are interested in a different backend, look [here](docs/simulation.md).
If you are interested in a stable release of Vortex, you can download the latest release [here](https://github.com/vortexgpgpu/vortex/releases/latest). Otherwise, you can pull the most recent, but (potentially) unstable version as shown below. The following steps demonstrate how to build and run Vortex with the default driver: SimX. If you are interested in a different backend, look [here](docs/simulation.md).

### Supported OS Platforms
- Ubuntu 18.04, 20.04
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ In an effort to keep `vortex` organized, permissions to directly create branches
However, contributions are strongly encouraged and keep the project moving forward! Here is the procedure for contributing:

1. Create a fork of `vortex`
2. In your fork, create a branch that briefly explains the work you are adding (ie: `develop-documentation`) branches from `develop` and adds some documentation
3. Make your changes on your new branch in your fork. You may create as many commits as you need, which might be common if you are making multiple iterations
2. In your fork, create a branch from `master` that briefly explains the work you are adding (ie: `develop-documentation`)
3. Make your changes on the new branch in your fork. You may create as many commits as you need, which might be common if you are making multiple iterations
4. Since you are the owner of your fork, you have full permissions to push commits to your fork
4. When you are satisfied with the changes on your fork, you can open a PR from your fork using the online interface
5. If you recently made a push, you will get automatically get a prompt on Github online to create a PR, which you can press
Expand All @@ -32,6 +32,6 @@ However, contributions are strongly encouraged and keep the project moving forwa
15. When all merge conflicts are resolved, changes are made, and tests pass you can have an admin merge your PR

## What Makes a Good Contribution?
- If you are contributing code changes, then review `testing.md` to ensure your tests are integrated into the CI pipeline
- If you are contributing code changes, then review [testing.md](./testing.md) to ensure your tests are integrated into the [CI pipeline](continuous_integration.md)
- During a PR, you should consider the advice you are provided by your reviewers. Remember you keep adding commits to an open PR!
- If your change aims to fix an issue opened on Github, please tag that issue in the PR itself
2 changes: 1 addition & 1 deletion docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Compile your test: `$ make -C tests/regression/<test-name>`
Run your test: `$ ./ci/blackbox.sh --driver=simx --app=<test-name> --debug`

## Adding Your Tests to the CI Pipeline
See `continuous_integration.md`
If you are a contributor, then you will need to add tests that integrate into the continuous integration pipeline. Remember, Pull Requests cannot be merged unless new code has tests and existing tests do not regress. See more at [contributing.md](contributing.md) and [continuous_integration.md](continuous_integration.md).

0 comments on commit 8155173

Please sign in to comment.