Skip to content

Commit

Permalink
Revert #14 Ownership Change (#15)
Browse files Browse the repository at this point in the history
* Revert ownership change

* Add package rename to CHANGES
  • Loading branch information
ZachNewbery authored Dec 5, 2022
1 parent 745a6ca commit 5017fcd
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Thank you for contributing to this project! You must fill out the information be
Closes [issue link]

<!-- If there's an existing issue for your change, please link to it in the brackets above.
If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/gap-packages/typeset/new/choose. -->
If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/ZachNewbery/typeset/new/choose. -->

### What's being changed (if available, include any code snippets, screenshots, or gifs):

Expand Down
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
--- v1.1 (current release) ---

- Renamed package to 'typeset', and gave ownership to 'gap-packages' organisation
- Renamed package to 'typeset'
- Added digraph integration to LaTeX generation with raw dot and dot2tex options
- Implemented rendering methods to allow users to view LaTeX output via MathJax, pdflatex, or Overleaf
- Reworked permutation handling to include \left and \right for LaTeX output
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Welcome! To get an overview of the package, read the [README](README.md). Here a

#### Create a new issue

If you spot a problem or find something you want to add, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a [new issue](https://github.com/gap-packages/typeset/issues/new).
If you spot a problem or find something you want to add, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a [new issue](https://github.com/ZachNewbery/typeset/issues/new).

#### Solve an issue

Scan through the [existing issues](https://github.com/gap-packages/typeset/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](https://github.com/gap-packages/typeset/labels) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
Scan through the [existing issues](https://github.com/ZachNewbery/typeset/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](https://github.com/ZachNewbery/typeset/labels) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

### Types of Contributions

Expand All @@ -42,7 +42,7 @@ First, it is best to create a new directory named after the language within the

Within this directory, you'll want to have at least two files, a _lang_.gd and a _lang_.gi. These files will follow the typical layout for GAP declaration and implementation files, and will contain the language-specific functions for your new implementation.

Once your files have been created, the next step will be implementing the operation to generate template strings for your language. As described in the [documentation](http://gap-packages.github.io/typeset/doc/chap1_mj.html), the framework works by calling language-specific functions to generate language-specific template strings followed by populating them with a language-agnostic list of semantic features pertaining to the GAP object being typeset.
Once your files have been created, the next step will be implementing the operation to generate template strings for your language. As described in the [documentation](http://ZachNewbery.github.io/typeset/doc/chap1_mj.html), the framework works by calling language-specific functions to generate language-specific template strings followed by populating them with a language-agnostic list of semantic features pertaining to the GAP object being typeset.

Therefore, you'll want to implement a method of the name Gen<em>Lang</em>Tmpl (only the first letter of the language should be capitalised) for any and all of the types you're looking to typeset. It may also be a good idea to have a default fallback to the core GAP method `String`, as many objects may not even need any specific changes to get them typeset!

Expand Down
6 changes: 3 additions & 3 deletions PackageInfo.g
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Persons := [

SourceRepository := rec(
Type := "git",
URL := "https://github.com/gap-packages/typeset",
URL := "https://github.com/ZachNewbery/typeset",
),
IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
PackageWWWHome := "https://gap-packages.github.io/typeset/",
PackageWWWHome := "https://ZachNewbery.github.io/typeset/",
PackageInfoURL := Concatenation( ~.PackageWWWHome, "PackageInfo.g" ),
README_URL := Concatenation( ~.PackageWWWHome, "README.md" ),
ArchiveURL := Concatenation( ~.SourceRepository.URL,
Expand All @@ -50,7 +50,7 @@ ArchiveFormats := ".tar.gz",
## "dev" for development versions of packages
## "other" for all other packages
##
Status := "submitted",
Status := "dev",

AbstractHTML := "",

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Build Status](https://github.com/gap-packages/typeset/workflows/CI/badge.svg?branch=main)](https://github.com/gap-packages/typeset/actions?query=workflow%3ACI+branch%3Amain)
[![Code Coverage](https://codecov.io/github/gap-packages/typeset/coverage.svg?branch=main&token=)](https://codecov.io/gh/gap-packages/typeset)
[![Build Status](https://github.com/ZachNewbery/typeset/workflows/CI/badge.svg?branch=main)](https://github.com/ZachNewbery/typeset/actions?query=workflow%3ACI+branch%3Amain)
[![Code Coverage](https://codecov.io/github/ZachNewbery/typeset/coverage.svg?branch=main&token=)](https://codecov.io/gh/ZachNewbery/typeset)

# The typeset GAP package
This package implements a framework for automatic typesetting of common GAP objects,
Expand All @@ -22,7 +22,7 @@ within GAP to see another relevant part of the manual).
Full information and documentation can be found in the manual, available
as a [PDF](doc/manual.pdf) or as HTML on the package homepage at

<https://gap-packages.github.io/typeset>
<https://ZachNewbery.github.io/typeset>

## Contributing
If you'd like to contribute to the development of this project, feel free to read
Expand All @@ -32,7 +32,7 @@ the [contributing guide](CONTRIBUTING.md). All help is greatly appreciated!
If you have any questions, or just want some off-topic discussion, check out the
discussions area of the repository:

<https://github.com/gap-packages/typeset/discussions>
<https://github.com/ZachNewbery/typeset/discussions>

This is the place to go if you have any new ideas you want to flesh out before
committing to writing out an issue, or are having any problems you think might not
Expand All @@ -41,7 +41,7 @@ be a bug!
## Bug Reports and Feature Requests
Please submit bug reports and feature requests via the GitHub issue tracker:

<https://github.com/gap-packages/typeset/issues>
<https://github.com/ZachNewbery/typeset/issues>

# License
typeset is free software; you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion doc/title.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<Author>
Zachariah Newbery<Alt Only="LaTeX"><Br/></Alt>
<Email>[email protected]</Email>
<Homepage>https://gap-packages.github.io</Homepage>
<Homepage>https://zachnewbery.com</Homepage>

</Author>
<Date>
Expand Down

0 comments on commit 5017fcd

Please sign in to comment.