Skip to content

Commit 33c89ad

Browse files
committed
updated development information and reordered content
1 parent ca16300 commit 33c89ad

1 file changed

Lines changed: 17 additions & 8 deletions

File tree

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,7 @@ supported version being 0.93.
1515

1616
## Requirements
1717
* Java 8
18-
* gradle
19-
20-
## Build
21-
Inside the bagit-java root directory, run `gradle distZip`. This will create a .zip file under build/distributions,
22-
bagit-\<VERSION\>.zip. To create an office release you should specify the version by running `gradle distZip -Pversion=<VERSION>`
18+
* gradle (for development only)
2319

2420
## Major differences between version 5 and 4.*
2521
##### Commandline
@@ -29,9 +25,6 @@ We no longer support directly serializing a bag. But if that is something you re
2925
##### Fetching
3026
We no longer support fetching. This is due to the various protocalls that could be involved. Again, if this is something you need, there are much better java libraries out there that you can use to fill this functionality.
3127

32-
### Note if using with Eclipse
33-
Simply run `gradle eclipse` and it will automatically create a eclipse project for you that you can import.
34-
3528
### Examples
3629
The "new" bagit interface is very intuitive, but here are some easy to follow examples. Instead of returning messages like in the old interface, now it throws errors so you don't have to parse messages to understand what happened.
3730

@@ -71,6 +64,22 @@ if(BagVerifier.canQuickVerify(bag)){
7164
}
7265
```
7366

67+
## Developing Bagit-Java
68+
Bagit-Java uses [Grad;e](https://gradle.org/) for its build system. Check out the great [documentation](https://docs.gradle.org/current/userguide/userguide_single.html) to learn more.
69+
##### Building a Jar
70+
Inside the bagit-java root directory, run `gradle jar`.
71+
##### Running tests and code quality checks
72+
Inside the bagit-java root directory, run `gradle check`.
73+
##### Uploading to maven central
74+
1. Follow their guides
75+
1. http://central.sonatype.org/pages/releasing-the-deployment.html
76+
2. https://issues.sonatype.org/secure/Dashboard.jspa
77+
2. Once you have access, to create an office release and upload it you should specify the version by running `gradle -Pversion=<VERSION> uploadArchives`
78+
1. *Don't forget to tag the repository!*
79+
80+
### Note if using with Eclipse
81+
Simply run `gradle eclipse` and it will automatically create a eclipse project for you that you can import.
82+
7483
### Roadmap
7584
* Further refine reading and writing of bags version 0.93-0.97
7685
* Integrate new proposed specification we are calling "dot bagit"

0 commit comments

Comments
 (0)