Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
Manuel Benz committed Jun 13, 2020
1 parent d9c68ea commit 99443d3
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 902 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Currently, Soot follows the [git-flow branching model](http://nvie.com/posts/a-s
All our nightly tests and builds operate on develop branch.

## Pull Request
> Note: If you already have a fork of Soot and need to merge our formatting changes, [this](https://github.com/Sable/soot/wiki/Merging-changes-after-introduction-of-formatting-guidelines) might help.
> Note: If you already have a fork of Soot and need to merge our formatting changes, [this](https://github.com/soot-oss/soot/wiki/Merging-changes-after-introduction-of-formatting-guidelines) might help.
To fix a problem in Soot or to contribute to Soot you can fork the Soot project on GitHub. This will generate a personal cloned repository for you to work on. To reincorporate your changes into Soot after they have been completed and tested, just send us a [pull request](https://help.github.com/articles/using-pull-requests). This will allow us to review your changes and merge them into the develop branch.

Expand All @@ -14,15 +14,15 @@ To fix a problem in Soot or to contribute to Soot you can fork the Soot project
Pull requests will have to conform to our coding style guidelines which are _as close as possible_* to the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). Our build server will reject pull requests that do not comply with our guidelines.

Tutorials on how to apply automatic formatting and style enhancements can be found here:
* [Eclipse](https://github.com/Sable/soot/wiki/Formatting-for-Eclipse)
* [IntelliJ Idea](https://github.com/Sable/soot/wiki/Formatting-for-IntelliJ)
* [Eclipse](https://github.com/soot-oss/soot/wiki/Formatting-for-Eclipse)
* [IntelliJ Idea](https://github.com/soot-oss/soot/wiki/Formatting-for-IntelliJ)

Compliance with our guidelines is ensured by the Maven Checkstyle plugin. One can run the checks by invoking `mvn checkstyle:check`. Also, the check is bound to the Maven's `verify` phase.
Our build server will reject pull requests with existing violations.

### License header

Newly created classes will have to have a [correct license header](https://github.com/Sable/soot/wiki/License-Header) right after the _package declaration_ of the class. Our build server will reject pull requests with missing license headers. The license check can be run locally by invoking `mvn license:check-file-header` or during the `verify` phase.
Newly created classes will have to have a [correct license header](https://github.com/soot-oss/soot/wiki/License-Header) right after the _package declaration_ of the class. Our build server will reject pull requests with missing license headers. The license check can be run locally by invoking `mvn license:check-file-header` or during the `verify` phase.

**Make sure that `mvn clean verify` terminates successfully before setting up a pull request or committing to the repository directly!**

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![Build Status](https://github.com/Sable/soot/workflows/Soot%20CI/badge.svg?branch=master)](https://github.com/Sable/soot/actions)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/Sable/soot)
[![Build Status](https://github.com/soot-oss/soot/workflows/Soot%20CI/badge.svg?branch=master)](https://github.com/soot-oss/soot/actions)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/soot-oss/soot)

# Using Soot? Let us know about it!
We are regularly applying for funding to help us maintain Soot. You can help us immensely by letting us know about [**projects that use Soot**](https://github.com/Sable/soot/wiki/Users-of-Soot), both commercially or in the form of research tools.
We are regularly applying for funding to help us maintain Soot. You can help us immensely by letting us know about [**projects that use Soot**](https://github.com/soot-oss/soot/wiki/Users-of-Soot), both commercially or in the form of research tools.

Also many thanks to [![JProfiler](https://www.ej-technologies.com/images/product_banners/jprofiler_small.png)](https://www.ej-technologies.com/products/jprofiler/overview.html) for supporting Soot with a free-to-use open source license!

Expand Down Expand Up @@ -33,9 +33,9 @@ See http://www.sable.mcgill.ca/soot/ for details.

# How do I get started with Soot?

We have some documentation on Soot in the [wiki](https://github.com/Sable/soot/wiki) and also a large range of [tutorials](http://www.sable.mcgill.ca/soot/tutorial/index.html) on Soot.
We have some documentation on Soot in the [wiki](https://github.com/soot-oss/soot/wiki) and also a large range of [tutorials](http://www.sable.mcgill.ca/soot/tutorial/index.html) on Soot.

For detailed information please also consider the Soot's [JavaDoc and Options](https://github.com/Sable/soot/wiki/Options-and-JavaDoc) Documentations.
For detailed information please also consider the Soot's [JavaDoc and Options](https://github.com/soot-oss/soot/wiki/Options-and-JavaDoc) Documentations.

# Including Soot in your Project

Expand Down Expand Up @@ -66,7 +66,7 @@ The `soot-<RELEASE>.jar` file contains only Soot, allowing you to manually pick

# Building Soot yourself

If you cannot work with the prebuild versions and need to build Soot on your own, please consider the [wiki](https://github.com/Sable/soot/wiki/Building-Soot-from-the-Command-Line-(Recommended)) for further steps.
If you cannot work with the prebuild versions and need to build Soot on your own, please consider the [wiki](https://github.com/soot-oss/soot/wiki/Building-Soot-from-the-Command-Line-(Recommended)) for further steps.

# About Soot's source code

Expand All @@ -77,7 +77,7 @@ mailing list at: http://www.sable.mcgill.ca/mailman/listinfo/soot-list/

# How do I contribute to Soot?

We are happy to accept arbitrary improvements to Soot in form of GitHub pull requests. Please read our [contribution guidelines](https://github.com/Sable/soot/wiki/Contributing-to-Soot) before setting up a pull request.
We are happy to accept arbitrary improvements to Soot in form of GitHub pull requests. Please read our [contribution guidelines](https://github.com/soot-oss/soot/wiki/Contributing-to-Soot) before setting up a pull request.

# Please help us improve Soot!
You are using Soot and would like to help us support it in the future? Then please support us by filling out [this little web form](https://goo.gl/forms/rk1oSxFIxAH0xaf52).
Expand Down
192 changes: 0 additions & 192 deletions README.md.orig

This file was deleted.

4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h4>Downloads:</h4>
<blockquote>
<h4>Repository Access:</h4>
<p>We are using Git on Github for version control.</p>
<a href="https://github.com/Sable/soot">Please check the
<a href="https://github.com/soot-oss/soot">Please check the
instructions on Github to see how to check out Soot.</a><br>
<br>
In order to compile Soot from source, you will also need a
Expand All @@ -149,7 +149,7 @@ <h4>Repository Access:</h4>
related seems broken you may need to get the latest Jasmin from the <a
href="https://github.com/Sable/jasmin">Jasmin Github repository</a>.</p>
<p>You can also browse our latest version of the Soot
repository <a href="https://github.com/Sable/soot/commits/master">on
repository <a href="https://github.com/soot-oss/soot/commits/master">on
Github as well</a>.</p>
</blockquote>
<blockquote>
Expand Down
Loading

0 comments on commit 99443d3

Please sign in to comment.