Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
cloogle.org
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Cloogle
cloogle.org
Commits
224059d8
Verified
Commit
224059d8
authored
Oct 21, 2018
by
Camil Staps
🚀
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation
parent
193c2336
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
16 additions
and
13 deletions
+16
-13
CONTRIBUTING.md
CONTRIBUTING.md
+12
-0
README.md
README.md
+3
-12
backend/Cloogle
backend/Cloogle
+1
-1
No files found.
CONTRIBUTING.md
View file @
224059d8
...
...
@@ -68,6 +68,18 @@ We will take immediate action.
If the library is not well-known it is advised to first open an issue to see
whether it is suitable to be indexed by cloogle.
### Preparation
Your library will be most easily accessible when:
-
Functions, type definitions, classes and modules are documented. For details
on the documentation format, see
[
DOCUMENTATION.md
](
https://gitlab.science.ru.nl/clean-and-itasks/clean-platform/blob/master/doc/DOCUMENTATION.md
)
in Platform.
-
Macros have types using the
`@type`
documentation field.
Having documentation is not a strict requirement, however.
### Updating the index
To add a library you have to modify
[
`libs.json`
](
/libs.json
)
. This file is a
JSON record with three collections of Clean libraries. Usually, you should add
the new library to the
`Miscellaneous`
collection. Please keep the alphabetic
...
...
README.md
View file @
224059d8
...
...
@@ -17,7 +17,7 @@ find usages.
-
[
Frontends
](
#frontends
)
-
[
Auxiliary tools
](
#auxiliary-tools
)
-
[
Interfacing with Cloogle
](
#interfacing-with-cloogle
)
-
[
Preparing a library for indexing
](
#preparing-a-library-for-indexing
)
-
[
Adding a library to the index
](
#adding-a-library-to-the-index
)
-
[
Local setup
](
#local-setup
)
-
[
Authors, copyright & license
](
#authors-copyright--license
)
...
...
@@ -94,17 +94,8 @@ These error messages are indexed by the frontend rather than the backend.
Additionally, the HTTP API may give return codes above 150, which are not used
by the TCP API. For the meaning of the return codes, see
[
Cloogle.API (icl)
][]
.
## Preparing a library for indexing
Your library will be most easily accessible when:
-
Functions, type definitions, classes and modules are documented. For details
on the documentation format, see the README of the
[
Cloogle
][]
submodule.
-
Macros have types using the
`@type`
documentation field.
Having documentation is not a strict requirement, however.
To add your library to the index, follow the steps in
[
CONTRIBUTING.md
](
/CONTRIBUTING.md#3-i-just-want-to-add-library-x
)
and create a
pull request.
## Adding a library to the index
See
[
CONTRIBUTING.md
](
/CONTRIBUTING.md#3-i-just-want-to-add-library-x
)
.
## Local setup
After installing
[
docker-compose
][]
run the following commands:
...
...
Cloogle
@
363368ba
Compare
dffef780
...
363368ba
Subproject commit
dffef780dc70c0611d73e3eeacc0f04ac4b63619
Subproject commit
363368badb0b2a2609ab1ea54fd16aba8fe55e68
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment