mirror of
https://github.com/carp-lang/Carp.git
synced 2024-09-11 05:25:28 +03:00
feat: Better docs structure
This commit is contained in:
Erik Svedang
parent
7932fc8612
commit
3df10e997c
@ -23,13 +23,9 @@ The key features of Carp are the following:
|
||||
* Straightforward integration with existing C code
|
||||
|
||||
## Learn more
|
||||
|
||||
* [Installation](docs/Install.md) - how to build and configure the Carp compiler
|
||||
* [The Compiler Manual](docs/Manual.md) - how to compile code and configure your projects
|
||||
* [The Compiler Manual](docs/Manual.md) - how to install and use the compiler
|
||||
* [Carp Language Guide](docs/LanguageGuide.md) - syntax and semantics of the language
|
||||
* [Core Docs](http://carp-lang.github.io/carp-docs/core/core_index.html) - documentation for our standard library
|
||||
* [Libraries](docs/Libraries.md) - how to work with libraries and modules
|
||||
* [Tooling](docs/Tooling.md) - supported editors
|
||||
* [Game Example](examples/reptile.carp) - a Snake clone in Carp
|
||||
|
||||
The Carp REPL has built-in documentation, run ```(help)``` to access it!
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
# Installation
|
||||
|
||||
Carp is mainly developed on macOS, but it also works fine on Linux. There is ongoing work on Windows support but it's not completely done yet.
|
||||
## Latest release
|
||||
|
||||
See [https://github.com/carp-lang/Carp/releases](https://github.com/carp-lang/Carp/releases).
|
||||
|
||||
## Building the Carp executable from source
|
||||
|
||||
|
||||
@ -1,4 +1,17 @@
|
||||
## The Compiler
|
||||
## The Compiler Manual
|
||||
|
||||
### Related pages
|
||||
|
||||
* [Installation](docs/Install.md) - how to acquire and configure the Carp compiler
|
||||
* [Tooling](docs/Tooling.md) - supported editors
|
||||
* [Libraries](docs/Libraries.md) - how to work with libraries and modules
|
||||
* [Macros](docs/Macros.md) - a guide to the Carp macro system
|
||||
* [Embedded](docs/Embedded.md) - tips and tricks for working with Carp on embedded system
|
||||
* [Terminology](docs/Terminology.md) - commonly used terms and what we mean with them
|
||||
|
||||
To learn more about the Carp language and its syntax and semantics, check out the [Carp Language Guide](docs/LanguageGuide.md).
|
||||
|
||||
### Basics
|
||||
|
||||
The Carp language is very tightly integrated with the REPL, everything you want to do to your program can be controlled from here.
|
||||
|
||||
|
||||
105
docs/Research.md
105
docs/Research.md
@ -1,105 +0,0 @@
|
||||
https://news.ycombinator.com/item?id=12039268
|
||||
|
||||
# C PROGRAMMING, LLVM, AND DEBUGGING
|
||||
|
||||
- http://clang.llvm.org/docs/AddressSanitizer.html
|
||||
- https://www.iar.com/support/resources/articles/advanced-preprocessor-tips-and-tricks/
|
||||
- http://jvns.ca/blog/2016/03/01/a-few-notes-on-the-stack/
|
||||
- https://www.recurse.com/blog/7-understanding-c-by-learning-assembly
|
||||
- http://msm.runhello.com/p/1003
|
||||
- http://stackoverflow.com/questions/2505385/classes-and-static-variables-in-shared-libraries
|
||||
- http://www.gameaipro.com/GameAIPro/GameAIPro_Chapter15_Runtime_Compiled_C++_for_Rapid_AI_Development.pdf
|
||||
- https://fsharpforfunandprofit.com/posts/fsharp-decompiled/
|
||||
- http://kristerw.blogspot.se/2016/05/type-based-aliasing-in-c.html
|
||||
- https://github.com/hellerve/sc/tree/real_closures
|
||||
- https://yosefk.com/blog/c-as-an-intermediate-language.html
|
||||
|
||||
# LAMBDAS
|
||||
- http://walfield.org/blog/2010/08/25/lambdas-in-c.html
|
||||
|
||||
# OWNERSHIP & BORROWING
|
||||
|
||||
- https://gitlab.redox-os.org/redox-os/rust/tree/3b49b27e0cb07c8735b534c3825b491a585ab404/src/librustc_borrowck/borrowck
|
||||
- https://rust-lang.github.io/rustc-guide/borrow_check.html
|
||||
- https://github.com/rust-lang/rfcs/blob/master/text/2094-nll.md#detailed-design
|
||||
- http://ticki.github.io/blog/lambda-crabs-part-1-a-mathematical-introduction-to-lifetimes-and-regions/
|
||||
|
||||
- http://smallcultfollowing.com/babysteps/blog/2016/04/27/non-lexical-lifetimes-introduction/
|
||||
- http://smallcultfollowing.com/babysteps/blog/2016/05/04/non-lexical-lifetimes-based-on-liveness/
|
||||
- http://smallcultfollowing.com/babysteps/blog/2016/05/09/non-lexical-lifetimes-adding-the-outlives-relation/
|
||||
- http://blog.piston.rs/2016/01/23/dynamo/
|
||||
- http://evincarofautumn.blogspot.se/2016/01/thoughts-on-using-fractional-types-to.html
|
||||
- http://andrewbrinker.github.io/blog/2016/03/27/string-types-in-rust/
|
||||
- http://www.pipeline.com/~hbaker1/LinearLisp.html
|
||||
- http://smallcultfollowing.com/babysteps/blog/2016/04/27/non-lexical-lifetimes-introduction/
|
||||
- https://doc.rust-lang.org/book/deref-coercions.html
|
||||
- http://ticki.github.io/blog/lambda-crabs-part-1-a-mathematical-introduction-to-lifetimes-and-regions/
|
||||
- https://gankro.github.io/blah/linear-rust/
|
||||
- http://smallcultfollowing.com/babysteps/blog/2018/04/27/an-alias-based-formulation-of-the-borrow-checker/
|
||||
|
||||
# MODULES & FUNCTORS
|
||||
|
||||
- http://homepages.inf.ed.ac.uk/mfourman/teaching/mlCourse/notes/sml-modules.html
|
||||
- https://www.cse.unsw.edu.au/~chak/papers/modules-classes.pdf
|
||||
|
||||
# TYPES
|
||||
|
||||
- https://lambdacube3d.wordpress.com/2016/03/03/tuples-as-heterogeneous-lists/
|
||||
- https://jeltsch.wordpress.com/2016/02/22/generic-programming-in-haskell/
|
||||
- http://okmij.org/ftp/ML/generalization.html
|
||||
- http://www.cs.cornell.edu/courses/cs312/2005sp/lectures/rec22.asp
|
||||
- http://www.cs.cornell.edu/courses/cs3110/2011sp/lectures/lec26-type-inference/type-inference.htm
|
||||
- http://www.scheme.com/tspl4/examples.html#./examples:h10
|
||||
|
||||
# CSP
|
||||
|
||||
- http://reaktor.com/blog/why-csp-matters-ii-how-do-i-know-sync-works/
|
||||
|
||||
# GC
|
||||
|
||||
- http://prl.ccs.neu.edu/blog/2016/05/24/measuring-gc-latencies-in-haskell-ocaml-racket/
|
||||
|
||||
# MACROS
|
||||
- https://luxlang.gitbooks.io/the-lux-programming-language/content/chapter10.html
|
||||
- http://www.ccs.neu.edu/home/stchang/popl2017/
|
||||
|
||||
# OTHER LANGUAGES
|
||||
|
||||
- https://wingolog.org/archives/2016/02/08/a-lambda-is-not-necessarily-a-closure
|
||||
- http://alex-charlton.com/posts/Prototype_to_polish_Making_games_in_CHICKEN_Scheme_with_Hypergiant/
|
||||
- http://beautifulracket.com/first-lang.html
|
||||
- http://stackoverflow.com/questions/4899113/fixed-point-combinator-for-mutually-recursive-functions/5272086#5272086
|
||||
- http://klisp.org
|
||||
- http://gliese1337.blogspot.se/2012/04/schrodingers-equation-of-software.html
|
||||
- https://github.com/kiselgra/c-mera
|
||||
- https://github.com/wolfgangj/bone-lisp/
|
||||
- https://github.com/akkartik/mu
|
||||
- https://github.com/haskell-lisp/liskell
|
||||
- https://github.com/PistonDevelopers/dyon/pull/318
|
||||
- https://github.com/namin/inc
|
||||
- http://nightmare.com/rushing/irken.html
|
||||
|
||||
# LANGUAGE DESIGN
|
||||
|
||||
- http://www.complang.tuwien.ac.at/kps2015/proceedings/KPS_2015_submission_29.pdf
|
||||
- http://www.lihaoyi.com/post/WhatsinaBuildTool.html
|
||||
- http://prog21.dadgum.com/136.html
|
||||
- https://existentialtype.wordpress.com/2011/03/19/dynamic-languages-are-static-languages/
|
||||
|
||||
# GRAPHS
|
||||
|
||||
- https://en.wikipedia.org/wiki/Strongly_connected_component
|
||||
- https://en.wikipedia.org/wiki/Transitive_closure#In_graph_theory
|
||||
|
||||
# GRAPHICS
|
||||
|
||||
- https://medium.com/@evanwallace/easy-scalable-text-rendering-on-the-gpu-c3f4d782c5ac#.ajyuy8weu
|
||||
- https://pomax.github.io/bezierinfo/
|
||||
|
||||
# WEB ASSEMBLY
|
||||
- https://github.com/mbasso/awesome-wasm
|
||||
|
||||
# TO TRY
|
||||
|
||||
- let fun ident(x) => x
|
||||
- in ident(ident)(2) end
|
||||
Loading…
Reference in New Issue
Block a user