Skip to content

Commit be520b6

Browse files
committed
update docs, bump version
1 parent b0c0ff8 commit be520b6

File tree

2 files changed

+25
-27
lines changed

2 files changed

+25
-27
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ b) the "Artistic License"
77

88
--- The GNU General Public License, Version 1, February 1989 ---
99

10-
This software is Copyright (c) 2021-2022 by Gavin Hayes.
10+
This software is Copyright (c) 2021-2024 by Gavin Hayes.
1111

1212
This is free software, licensed under:
1313

lib/Perl/Dist/APPerl.pm

+24-26
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package Perl::Dist::APPerl;
2-
# Copyright (c) 2022 Gavin Hayes, see LICENSE in the root of the project
3-
use version 0.77; our $VERSION = qv(v0.5.0);
2+
# Copyright (c) 2024 Gavin Hayes, see LICENSE in the root of the project
3+
use version 0.77; our $VERSION = qv(v0.6.0);
44
use strict;
55
use warnings;
66
use JSON::PP 2.0104 qw(decode_json);
@@ -763,7 +763,7 @@ $defconfig{defaultconfig} = 'full';
763763

764764
sub _build_def_config {
765765
return {
766-
base => ($_[0] // 'nobuild-v0.1.0'),
766+
base => ($_[0] // 'nobuild'),
767767
desc => 'description of this config',
768768
dest => 'perl.com'
769769
};
@@ -783,7 +783,7 @@ sub Init {
783783
}
784784

785785
# create project config
786-
my %jsondata = ( 'defaultconfig' => ($defaultconfig // 'nobuild-v0.1.0'));
786+
my %jsondata = ( 'defaultconfig' => ($defaultconfig // 'nobuild'));
787787
if($defaultconfig && ! exists $Configs->{apperl_configs}{$defaultconfig}) {
788788
$jsondata{apperl_configs} = {
789789
$defaultconfig => _build_def_config($base),
@@ -1731,8 +1731,8 @@ L<https://computoid.com/posts/Perl-is-Actually-Portable.html>.
17311731
17321732
=head1 SYNOPSIS
17331733
1734-
apperlm install-build-deps
1735-
apperlm-list
1734+
apperlm list
1735+
apperlm checkout full
17361736
apperlm configure
17371737
apperlm build
17381738
./perl.com /zip/bin/perldoc Perl::Dist::APPerl
@@ -1743,7 +1743,6 @@ L<https://computoid.com/posts/Perl-is-Actually-Portable.html>.
17431743
17441744
To build small APPerl from scratch:
17451745
1746-
apperlm install-build-deps
17471746
apperlm checkout small
17481747
apperlm configure
17491748
apperlm build
@@ -1752,12 +1751,11 @@ To start an APPerl project from an existing APPerl and build it:
17521751
17531752
mkdir src
17541753
mv perl.com src/
1755-
apperlm init --name your_config_name --base nobuild-v0.1.0
1754+
apperlm init --name your_config_name --base nobuild
17561755
apperlm build
17571756
17581757
To start an APPerl project and build from scratch:
17591758
1760-
apperlm install-build-deps
17611759
apperlm init --name your_config_name --base small
17621760
apperlm configure
17631761
apperlm build
@@ -1773,17 +1771,6 @@ and building APPerl.
17731771
17741772
=item *
17751773
1776-
C<apperlm install-build-deps> installs APPerl build dependencies,
1777-
currently, a fork of the perl5 source and the Cosmopolitan Libc. This
1778-
is only necessary if you are building APPerl from scratch (not using a
1779-
nobuild configuration). Initialization of the repos can be skipped by
1780-
passing the path to them locally. The cosmopolitan repo
1781-
initialization can be skipped with -c <path_to_repo> . The perl5 repo
1782-
initialization can be skipped with -p <path_to_repo>. This install is
1783-
done user specific, installs to $XDG_CONFIG_HOME/apperl .
1784-
1785-
=item *
1786-
17871774
C<apperlm init> creates an APPerl project, C<apperl-project.json>. The
17881775
project default configuration may to specified with -n <name>. If the
17891776
configuration does not exist, a new configuration will be created, and
@@ -1802,16 +1789,16 @@ release of Perl::Dist::APPerl.
18021789
18031790
=item *
18041791
1805-
C<apperlm checkout> sets the current APPerl config, this includes a
1806-
C<make veryclean> in the Perl repo and C<git checkout> in both Perl and
1807-
cosmo repos. The current config name is written to
1792+
C<apperlm checkout> sets the current APPerl config, including cleaning
1793+
or reestablishing the build dirs. The current config name is written to
18081794
C<.apperl/user-project.json> .
18091795
18101796
=item *
18111797
18121798
C<apperlm new-config> creates a new config and adds to to the project
18131799
config. -n specifies the name of the new config and must be provided.
1814-
-b specifies the base of the new config.
1800+
-b specifies the base of the new config. Alternatively, you can modify
1801+
C<apperl-project.json> directly.
18151802
18161803
=item *
18171804
@@ -1827,6 +1814,17 @@ C<zip> binary is required to build, see README.md for details. The
18271814
C<zip> binary path may be explictly set by passing in
18281815
--zippath <zip_binary_path> .
18291816
1817+
=item *
1818+
1819+
C<apperlm install-build-deps> installs APPerl build git dependencies.
1820+
This is now unnecessary unless you are doing vista builds or developing
1821+
APPerl itself. Note, vista builds are deprecated, see Changes.
1822+
Initialization of the repos can be skipped by passing the path to them
1823+
locally. The cosmopolitan repo initialization can be skipped with
1824+
-c <path_to_repo> . The perl5 repo initialization can be skipped with
1825+
-p <path_to_repo>. This install is done user specific, installs to
1826+
$XDG_CONFIG_HOME/apperl .
1827+
18301828
=back
18311829
18321830
=head1 USAGE
@@ -2074,7 +2072,7 @@ the parent config.
20742072
20752073
Build it and try it out. apperlm checkout is needed as Perl must be
20762074
rebuilt from scratch as the Configure flags changed and new files were
2077-
added to the perl5 repo.
2075+
added to the perl5 build dir.
20782076
20792077
apperlm checkout my_src_build_config
20802078
apperlm configure
@@ -2147,7 +2145,7 @@ Gavin Hayes, C<< <gahayes at cpan.org> >>
21472145
21482146
=head1 LICENSE AND COPYRIGHT
21492147
2150-
This software is copyright (c) 2022 by Gavin Hayes.
2148+
This software is copyright (c) 2024 by Gavin Hayes.
21512149
21522150
This is free software; you can redistribute it and/or modify it under
21532151
the same terms as the Perl 5 programming language system itself.

0 commit comments

Comments
 (0)