You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-8Lines changed: 29 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,20 +10,24 @@
10
10
[//]: #(see https://github.com/moznion/javadocio-badges for automatic javadoc)
11
11
12
12
## Description
13
+
13
14
The BAGIT LIBRARY is a software library intended to support the creation,
14
15
manipulation, and validation of bags. Its current version is 0.97. It is version aware with the earliest
15
16
supported version being 0.93.
16
17
17
18
## Requirements
18
-
* Java 8
19
-
* gradle (for development only)
19
+
20
+
- Java 8
21
+
- gradle (for development only)
20
22
21
23
## Support
22
-
1. The Digital Curation Google Group (https://groups.google.com/d/forum/digital-curation) is an open discussion list that reaches many of the contributors to and users of this open-source project
23
-
2. If you have found a bug please create a new issue on [the issues page](https://github.com/LibraryOfCongress/bagit-java/issues/new)
24
-
3. If you would like to contribute, please submit a [pull request](https://help.github.com/articles/creating-a-pull-request/)
25
24
26
-
## Major differences between version 5 and 4.*
25
+
1. The Digital Curation Google Group (https://groups.google.com/d/forum/digital-curation) is an open discussion list that reaches many of the contributors to and users of this open-source project
26
+
2. If you have found a bug please create a new issue on [the issues page](https://github.com/LibraryOfCongress/bagit-java/issues/new)
27
+
3. If you would like to contribute, please submit a [pull request](https://help.github.com/articles/creating-a-pull-request/)
28
+
29
+
## Major differences between version 5 and 4.\*
30
+
27
31
##### Command Line Interface
28
32
29
33
The 5.x versions do not include a command-line interface.
@@ -34,6 +38,7 @@ or switch to an alternative implementation such as
34
38
[BagIt for Ruby](https://github.com/tipr/bagit).
35
39
36
40
##### Serialization
41
+
37
42
Starting with the 5.x versions bagit-java no longer supports directly
38
43
serializing a bag to an archive file. The examples show how to implement a
39
44
custom serializer for the
@@ -43,15 +48,17 @@ and
43
48
formats.
44
49
45
50
##### Fetching
51
+
46
52
The 5.x versions do not include a core `fetch.txt` implementation. If you need
demonstrates how you can implement this feature with your additional application
50
56
and workflow requirements.
51
57
52
58
##### Internationalization
53
-
All logging and error messages have been put into a [ResourceBundle](https://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html).
54
-
This allows for all the messages to be translated to multiple languages and automatically used during runtime.
59
+
60
+
All logging and error messages have been put into a [ResourceBundle](https://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html).
61
+
This allows for all the messages to be translated to multiple languages and automatically used during runtime.
55
62
If you would like to contribute to translations please visit https://www.transifex.com/acdha/bagit-java/dashboard/ or https://crowdin.com/project/bagit-java.
56
63
57
64
##### New Interfaces
@@ -62,6 +69,7 @@ to follow modern Java practices and will require some changes to existing code:
62
69
### Examples of using the new bagit-java library
63
70
64
71
##### Create a bag from a folder using version 0.97
Bagit-Java uses [Gradle](https://gradle.org/) for its build system. Check out the great [documentation](https://docs.gradle.org/current/userguide/userguide_single.html) to learn more.
176
+
162
177
##### Running tests and code quality checks
178
+
163
179
Inside the bagit-java root directory, run `./gradlew check`.
2.Once you have access, to create an official release and upload it you should specify the version by running `./gradlew -Pversion=<VERSION> uploadArchives`
2. Once you have access, to create an official release and upload it you should specify the version by running `./gradlew -Pversion=<VERSION> bintrayUpload`
175
193
1. *Don't forget to tag the repository!*
176
194
195
+
177
196
### Noteif using with Eclipse
197
+
178
198
Simply run `./gradlew eclipse` and it will automatically create a eclipse project for you that you can import.
179
199
180
200
### Roadmapforthis library
181
201
*Fix bugs/issues reported with new library (on going)
0 commit comments