zig/README.md

45 lines
2.1 KiB
Markdown
Raw Normal View History

2018-05-13 06:07:55 +01:00
![ZIG](https://ziglang.org/zig-logo.svg)
2015-08-06 01:44:05 +01:00
2019-12-30 23:16:40 +00:00
A general-purpose programming language and toolchain for maintaining
**robust**, **optimal**, and **reusable** software.
2015-08-06 01:44:05 +01:00
## Resources
2021-02-19 23:38:04 +00:00
* [Introduction](https://ziglang.org/learn/#introduction)
* [Download & Documentation](https://ziglang.org/download)
* [Chapter 0 - Getting Started | ZigLearn.org](https://ziglearn.org/)
* [Community](https://github.com/ziglang/zig/wiki/Community)
2019-05-28 19:53:01 +01:00
* [Contributing](https://github.com/ziglang/zig/blob/master/CONTRIBUTING.md)
* [Code of Conduct](https://github.com/ziglang/zig/blob/master/CODE_OF_CONDUCT.md)
* [Frequently Asked Questions](https://github.com/ziglang/zig/wiki/FAQ)
2019-08-11 21:09:23 +01:00
* [Community Projects](https://github.com/ziglang/zig/wiki/Community-Projects)
2016-11-24 07:44:03 +00:00
## Installation
2015-12-07 04:55:28 +00:00
* [download a pre-built binary](https://ziglang.org/download/)
* [install from a package manager](https://github.com/ziglang/zig/wiki/Install-Zig-from-a-Package-Manager)
* [build from source](https://github.com/ziglang/zig/wiki/Building-Zig-From-Source)
* [bootstrap zig for any target](https://github.com/ziglang/zig-bootstrap)
delete all stage1 c++ code not directly related to compiling stage2 Deleted 16,000+ lines of c++ code, including: * an implementation of blake hashing * the cache hash system * compiler.cpp * all the linking code, and everything having to do with building glibc, musl, and mingw-w64 * much of the stage1 compiler internals got slimmed down since it now assumes it is always outputting an object file. More stuff: * stage1 is now built with a different strategy: we have a tiny zig0.cpp which is a slimmed down version of what stage1 main.cpp used to be. Its only purpose is to build stage2 zig code into an object file, which is then linked by the host build system (cmake) into stage1. zig0.cpp uses the same C API that stage2 now has access to, so that stage2 zig code can call into stage1 c++ code. - stage1.h is - stage2.h is - stage1.zig is the main entry point for the Zig/C++ hybrid compiler. It has the functions exported from Zig, called in C++, and bindings for the functions exported from C++, called from Zig. * removed the memory profiling instrumentation from stage1. Abandon ship! * Re-added the sections to the README about how to build stage2 and stage3. * stage2 now knows as a comptime boolean whether it is being compiled as part of stage1 or as stage2. - TODO use this flag to call into stage1 for compiling zig code. * introduce -fdll-export-fns and -fno-dll-export-fns and clarify its relationship to link_mode (static/dynamic) * implement depending on LLVM to detect native target cpu features when LLVM extensions are enabled and zig lacks CPU feature detection for that target architecture. * C importing is broken, will need some stage2 support to function again.
2020-09-18 02:29:38 +01:00
2020-09-11 19:30:21 +01:00
## License
The ultimate goal of the Zig project is to serve users. As a first-order
effect, this means users of the compiler, helping programmers to write better
2020-10-26 13:38:36 +00:00
software. Even more important, however, are the end-users.
2020-09-11 19:30:21 +01:00
2020-10-26 13:38:36 +00:00
Zig is intended to be used to help **end-users** accomplish their goals. Zig
should be used to empower end-users, never to exploit them financially, or to
2020-10-22 03:55:35 +01:00
limit their freedom to interact with hardware or software in any way.
2020-09-11 19:30:21 +01:00
However, such problems are best solved with social norms, not with software
licenses. Any attempt to complicate the software license of Zig would risk
2020-10-22 03:55:35 +01:00
compromising the value Zig provides.
2020-09-11 19:30:21 +01:00
Therefore, Zig is available under the MIT (Expat) License, and comes with a
2020-10-26 13:38:36 +00:00
humble request: use it to make software better serve the needs of end-users.
2020-10-22 03:55:35 +01:00
This project redistributes code from other projects, some of which have other
licenses besides MIT. Such licenses are generally similar to the MIT license
for practical purposes. See the subdirectories and files inside lib/ for more
details.