Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add src/README.txt and build/README.txt #21565

Closed
mkoeppe opened this issue Sep 22, 2016 · 12 comments
Closed

Add src/README.txt and build/README.txt #21565

mkoeppe opened this issue Sep 22, 2016 · 12 comments

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Sep 22, 2016

This ticket adds README files that explain the purpose of the src and build directories.

Also, src/setup.py sdist (#21516) is asking for a README, so we make it happy too.

CC: @vbraun @jdemeyer @embray @kiwifb @dimpase @fchapoton

Component: build

Author: Matthias Koeppe

Branch/Commit: 1b45e56

Reviewer: Dima Pasechnik

Issue created by migration from https://trac.sagemath.org/ticket/21565

@mkoeppe mkoeppe added this to the sage-7.4 milestone Sep 22, 2016
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Sep 22, 2016

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Sep 22, 2016

Commit: 39f5eb9

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Sep 22, 2016

Author: Matthias Koeppe

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Sep 22, 2016

comment:2

Needs review. New commits that improve/expand these descriptions are, of course, welcome too.


New commits:

39f5eb9Add READMEs

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Sep 22, 2016

Changed commit from 39f5eb9 to 1b45e56

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Sep 22, 2016

Branch pushed to git repo; I updated commit sha1. New commits:

1b45e56Fix typo in README

@dimpase
Copy link
Member

dimpase commented Sep 25, 2016

Reviewer: Dima Pasechnik

@dimpase
Copy link
Member

dimpase commented Sep 25, 2016

comment:5

looks good enough to me (I'm a bit unhappy about .txt suffix vs no such suffix in other READMEs, but OK).

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Sep 27, 2016

comment:6

Replying to @dimpase:

looks good enough to me

Is this a "positive review"?

I'm a bit unhappy about .txt suffix vs no such suffix in other READMEs, but OK

Note the majority of our README files already has .txt as a suffix.

$ find build -name README\*
build/pkgs/atlas/patches/ATLAS-lib/README
build/pkgs/bzip2/patches/autotools/README.autotools
build/pkgs/giac/patches/README.txt
build/pkgs/pari/patches/README.txt
build/sage_bootstrap/README
$ find src -name README\*
src/mac-app/tools/createDSStore/README.txt
src/sage/ext/mac-app/README
src/sage/libs/gap/test/README.txt
src/sage/rings/bernmm/README.txt
src/sage/rings/bernmm/README2.txt
src/sage/rings/padics/README.txt
src/sage/schemes/hyperelliptic_curves/hypellfrob/README
src/sage/tests/french_book/README

@dimpase
Copy link
Member

dimpase commented Sep 28, 2016

comment:7

OK - was in hurry and did not notice that I didn't set it to positive review, sorry.

@vbraun
Copy link
Member

vbraun commented Oct 5, 2016

Changed branch from u/mkoeppe/add_src_readme_txt_and_build_readme_txt to 1b45e56

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants