diff --git a/README.md b/README.md index a7563297..6b9ba18f 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,41 @@ sudo apt-get install omc ``` ### Add a new library -1. Put your library somewere public in git (or svn). -2. Edit repos.json and add the URL to your library and the commit hash (revision number for svn). -3. Commit your change. -4. Make sure you run the Hudson Job: OpenModelica_UPDATE_LIBRARIES to update the Makefiles +1. Put your library somewhere public in git. +2. Edit [repos.json](https://github.com/OpenModelica/OMLibraries/blob/master/repos.json) and add the URL to your library with the gittag or hash and branch name. + **Example for a public GitHub repository using a git tag:** + ```json + [...] + { + "core": true, // Is your library a core library (true) or another library (false) + "dest": "LibraryName", // The name of your library + "options": { + "gitbranch": "master", // Git branch (optional) + "gittag": "v1.0.0", // Git tag pointing to commit to be used + "license": "bsd3" // Under what license is your library published (optional) + }, + "rev": "v1.0.0", // Version of your library you tagged + "url": "https://github.com/UserName/LibraryName/.git" // URL of your GitHub repository + }, + [...] + ``` + + **Example for a public GitHub repository using a branch and commit hash:** + ```json + [...] + { + "core": true, // Is your library a core library (true) or another library (false) + "dest": "LibraryName", // The name of your library + "options": { + "gitbranch": "v1.0.0-maintenance", // Git branch + "license": "bsd3" // Under what license is your library published (optional) + }, + "rev": "802e7d85e35e14asdg53dsg1sdd6911804382f29", // Version of your library you tagged + "url": "https://github.com/UserName/LibraryName/.git" // URL of your GitHub repository + }, + [...] + ``` + Note that JSON doesn't allow comments, so delete all comments from the above examples. +3. Create a pull request with your changes. +4. One of the developers will then run the Hudson Job: OpenModelica_UPDATE_LIBRARIES to update the Makefiles \ No newline at end of file diff --git a/repos.json b/repos.json index 37860083..724d7cbe 100644 --- a/repos.json +++ b/repos.json @@ -694,21 +694,15 @@ { "core": true, "dest": "ThermoSysPro", - "multitarget": [ - { - "options": { - "gitbranch": "maint/3.1" - }, - "rev": "db81ae1b5a6a85f6c6c7693244cafa6087e18ff5" - }, - { - "options": { - "gitbranch": "master" - }, - "rev": "5cef9acb4dedf8af6f4638a4448f08a544ebd30b" - } + "options": { + "gittag": "v3.2", + "license": "bsd3" + }, + "rev": "v3.2", + "targets": [ + "ThermoSysPro 3.2" ], - "url": "https://openmodelica.org/git/ThermoSysPro.git" + "url": "https://github.com/ThermoSysPro/ThermoSysPro/.git" }, { "core": true,