DEVEL 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. Waf 2.0 is on https://gitlab.com/ita1024/waf
  2. ------------------------------------------------
  3. waflib the core library
  4. waflib/Tools essential waf tools
  5. waflib/extras contributed tools which are not included in the waf file by default
  6. build_system_kit examples of build systems that can be created from Waf
  7. tests various unit tests, most are unused anymore
  8. playground experimental examples and test, most tools lie in the folder waflib/extras
  9. demos integration tests - the folder can be configured as a standalone project
  10. demos/* integration tests and examples used as documentation
  11. docs documentation
  12. docs/sphinx project extracting the docstrings from the source code to create the API documentation
  13. Documentation
  14. -------------------------------------------------
  15. API documentation https://waf.io/apidocs/
  16. The Waf Book https://waf.io/book/
  17. General coding guidelines
  18. -------------------------
  19. * The code must run in both Python 2.6 to Python 3
  20. * Use tabs for Python file indentation
  21. * Use x.splitlines() instead of x.split('\n')
  22. * Avoid "except:" and "except Exception:"
  23. * Use Node.readf/Node.writef/Utils.readf/Utils.writef
  24. Pull requests
  25. -------------
  26. See https://gitlab.com/ita1024/waf
  27. When implementing complex features, please add examples in the showcase folder demos/
  28. for modules under waflib/Tools, under tests/ for platform-independent unit tests,
  29. or in playground/ for modules under waflib/extras.
  30. The files under waflib/Tools/ are kept API-compatible for the duration
  31. of a middle version (currently 2.0).