mirror of
https://github.com/hsjobeki/noogle.git
synced 2024-09-11 12:59:09 +03:00
Update README.md
This commit is contained in:
parent
1b72d4f6c4
commit
b2d2d7230a
19
README.md
19
README.md
@ -16,9 +16,24 @@ Noogle is a Nix API search engine. It allows you to search functions based on th
|
||||
|
||||
## How it works
|
||||
|
||||
The idea is to use a fork of `nixdoc`to generate json data from all functions. That have the `Type` field which is currently supported from nixdoc.
|
||||
### Indexers:
|
||||
|
||||
View the prototype [here](https://noogle.dev)
|
||||
Data collections need to be up-to-date
|
||||
Those collections are then combined and dumped somewhere (db / json)
|
||||
|
||||
For the indexing i currently use:
|
||||
|
||||
- Nixdoc (a fork) to collect nixpkgs.lib informations
|
||||
- nix __dump-builtins + builtins-types.json for the nix builtins
|
||||
|
||||
As some parts of nix already have nixos modules their input/output can be discovered. I still lack some tool to integrate that into noogle.
|
||||
|
||||
### Search:
|
||||
|
||||
- haskell-like types are parsed and splitted between input and ouput
|
||||
- text search, looks in all metadata fields for an exact matching word or character sequence. I dont have elastic search yet.
|
||||
|
||||
# View the prototype [here](https://noogle.dev)
|
||||
|
||||
## We need your help / what is missing
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user